﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class SpiceMethod
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class SpiceMethod
   ">
    <meta name="generator" content="docfx 2.52.0.0">
    
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    
    
    
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod">
  
  
  <h1 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod" class="text-break">Class SpiceMethod
  </h1>
  <div class="markdown level0 summary"><p>A default integration method as implemented by most Spice simulators.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html">ParameterSet</a></div>
    <div class="level2"><a class="xref" href="SpiceSharp.Simulations.TimeParameters.html">TimeParameters</a></div>
    <div class="level3"><a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.VariableTimestepConfiguration.html">VariableTimestepConfiguration</a></div>
    <div class="level4"><span class="xref">SpiceMethod</span></div>
      <div class="level5"><a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.Gear.html">Gear</a></div>
      <div class="level5"><a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.Trapezoidal.html">Trapezoidal</a></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="SpiceSharp.ParameterSets.IParameterSet.html">IParameterSet</a></div>
    <div><a class="xref" href="SpiceSharp.ICloneable.html">ICloneable</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.VariableTimestepConfiguration.html#SpiceSharp_Simulations_IntegrationMethods_VariableTimestepConfiguration_MaxStep">VariableTimestepConfiguration.MaxStep</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.VariableTimestepConfiguration.html#SpiceSharp_Simulations_IntegrationMethods_VariableTimestepConfiguration_MinStep">VariableTimestepConfiguration.MinStep</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.VariableTimestepConfiguration.html#SpiceSharp_Simulations_IntegrationMethods_VariableTimestepConfiguration_MaximumExpansion">VariableTimestepConfiguration.MaximumExpansion</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_Create_SpiceSharp_Simulations_IBiasingSimulationState_">TimeParameters.Create(IBiasingSimulationState)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_StartTime">TimeParameters.StartTime</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_StopTime">TimeParameters.StopTime</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_UseIc">TimeParameters.UseIc</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_TransientMaxIterations">TimeParameters.TransientMaxIterations</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_InitialConditions">TimeParameters.InitialConditions</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.TimeParameters.html#SpiceSharp_Simulations_TimeParameters_Validate">TimeParameters.Validate</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_Clone">ParameterSet.Clone()</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_SpiceSharp_ICloneable_Clone">ParameterSet.ICloneable.Clone()</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_CopyFrom_SpiceSharp_ICloneable_">ParameterSet.CopyFrom(ICloneable)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_SpiceSharp_ICloneable_CopyFrom_SpiceSharp_ICloneable_">ParameterSet.ICloneable.CopyFrom(ICloneable)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_SetParameter__1_System_String___0_">ParameterSet.SetParameter&lt;P&gt;(String, P)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_TrySetParameter__1_System_String___0_">ParameterSet.TrySetParameter&lt;P&gt;(String, P)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_GetProperty__1_System_String_">ParameterSet.GetProperty&lt;P&gt;(String)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_TryGetProperty__1_System_String___0__">ParameterSet.TryGetProperty&lt;P&gt;(String, P)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_CreateParameterSetter__1_System_String_">ParameterSet.CreateParameterSetter&lt;P&gt;(String)</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.ParameterSets.ParameterSet.html#SpiceSharp_ParameterSets_ParameterSet_CreatePropertyGetter__1_System_String_">ParameterSet.CreatePropertyGetter&lt;P&gt;(String)</a>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.Simulations.IntegrationMethods.html">SpiceSharp.Simulations.IntegrationMethods</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class SpiceMethod : VariableTimestepConfiguration, IParameterSet, ICloneable</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod__ctor_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.#ctor*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod__ctor" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.#ctor">SpiceMethod()</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected SpiceMethod()</code></pre>
  </div>
  <h3 id="properties">Properties
  </h3>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_AbsoluteTolerance_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.AbsoluteTolerance*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_AbsoluteTolerance" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.AbsoluteTolerance">AbsoluteTolerance</h4>
  <div class="markdown level1 summary"><p>Gets or sets the absolute tolerance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;abstol&quot;)]
[ParameterInfo(&quot;The absolute tolerance.&quot;)]
public double AbsoluteTolerance { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The absolute tolerance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_ChargeTolerance_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.ChargeTolerance*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_ChargeTolerance" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.ChargeTolerance">ChargeTolerance</h4>
  <div class="markdown level1 summary"><p>The tolerance on charge.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;chgtol&quot;)]
[ParameterInfo(&quot;The charge tolerance.&quot;)]
public double ChargeTolerance { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The charge tolerance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_InitialStep_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.InitialStep*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_InitialStep" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.InitialStep">InitialStep</h4>
  <div class="markdown level1 summary"><p>Gets or sets the initial timestep.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;step&quot;)]
[ParameterInfo(&quot;The initial timestep.&quot;)]
public double InitialStep { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The initial timestep.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_LteAbsTol_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.LteAbsTol*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_LteAbsTol" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.LteAbsTol">LteAbsTol</h4>
  <div class="markdown level1 summary"><p>The local truncation error absolute tolerance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;lteabstol&quot;)]
[ParameterInfo(&quot;The local truncation error absolute tolerance.&quot;)]
public double LteAbsTol { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The aboslute tolerance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_LteRelTol_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.LteRelTol*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_LteRelTol" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.LteRelTol">LteRelTol</h4>
  <div class="markdown level1 summary"><p>The local truncation error relative tolerance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;ltereltol&quot;)]
[ParameterInfo(&quot;The local truncation error relative tolerance.&quot;)]
public double LteRelTol { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The relative tolerance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_RelativeTolerance_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.RelativeTolerance*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_RelativeTolerance" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.RelativeTolerance">RelativeTolerance</h4>
  <div class="markdown level1 summary"><p>Gets or sets the relative tolerance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;reltol&quot;)]
[ParameterInfo(&quot;The relative tolerance.&quot;)]
public double RelativeTolerance { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The relative tolerance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_TrTol_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.TrTol*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_TrTol" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.TrTol">TrTol</h4>
  <div class="markdown level1 summary"><p>Gets or sets the transient tolerance factor.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;trtol&quot;)]
[ParameterInfo(&quot;The transient tolerance factor.&quot;)]
public double TrTol { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Double</span></td>
        <td><p>The transient tolerance factor.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_TruncateNodes_" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.TruncateNodes*"></a>
  <h4 id="SpiceSharp_Simulations_IntegrationMethods_SpiceMethod_TruncateNodes" data-uid="SpiceSharp.Simulations.IntegrationMethods.SpiceMethod.TruncateNodes">TruncateNodes</h4>
  <div class="markdown level1 summary"><p>Gets or sets a value indicating whether node voltages should be used to truncate the timestep.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[ParameterName(&quot;truncnodes&quot;)]
[ParameterInfo(&quot;Flag that specifies whether or not node voltages should be used to truncate the timestep.&quot;)]
public bool TruncateNodes { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p><code>true</code> if node voltages are used; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="SpiceSharp.ParameterSets.IParameterSet.html">IParameterSet</a>
  </div>
  <div>
      <a class="xref" href="SpiceSharp.ICloneable.html">ICloneable</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, String)</a>
  </div>
  <div>
      <a class="xref" href="SpiceSharp.Reflection.Documentation.html#SpiceSharp_Reflection_Documentation_Parameters_SpiceSharp_ParameterSets_IParameterSet_">Documentation.Parameters(IParameterSet)</a>
  </div>
  <div>
      <a class="xref" href="SpiceSharp.Reflection.Documentation.html#SpiceSharp_Reflection_Documentation_ParameterValues__1_SpiceSharp_ParameterSets_IParameterSet_System_Boolean_">Documentation.ParameterValues&lt;T&gt;(IParameterSet, Boolean)</a>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
